appointment-biz
CR Market
GET searchTimeSlot
This operation retrieves list of searchTimeSlot entity from Field service API.
URL
https://[localhost]:[port]/tmf-api/appointmentManagement/v1/{businessId}/searchTimeSlotURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (CR) identifying the business unit. | Y |
Headers
| name | value | description | required |
|---|---|---|---|
| client-id | string | The client-id identifying the channel. Minimum characters: 5 | Y |
| client-secret | string | Password associated with the client-id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
| channelId | string | Channel to business: default value: "ECOM". | N |
| lob | string | The Line of Business Identifier Ex: FIXED, PREPAID, POSTPAID | Y |
Query Param
| name | type | description | required |
|---|---|---|---|
| relatedParty.id | string | Unique identifier of the related entity. | Y for CR |
| requestedStartDate | string | Contains the first date when you can schedule the job. | Y for CR |
| requestedEndDate | string | requested end date for looking for available slots. | Y for CR |
| jobType | string | Job type which is looking for appointment slot. | Y for CR |
Data Model - Response
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| availableTimeSlot[] | array | Time slot | N (CR) |
| availableTimeSlot[].validFor | object | Start date and end date of the timeSlot | N (CR) |
| availableTimeSlot[].validFor.startDateTime | datetime | Start date of the timeSlot | N (CR) |
| availableTimeSlot[].validFor.endDateTime | datetime | End date of the timeSlot | N (CR) |
| relatedParty | object | RelatedParty reference. A related party defines party or party role linked to a specific entity. | N (CR) |
| relatedParty.id | string | Unique identifier of a related Party | N (CR) |
| requestedTimeSlot | array | Time slot | N (CR) |
| requestedTimeSlot.validFor | object | Start date and end date of the timeSlot | N (CR) |
| requestedTimeSlot.validFor.startDateTime | datetime | Start date of the timeSlot | N (CR) |
| requestedTimeSlot.validFor.endDateTime | datetime | End date of the timeSlot | N (CR) |
Key considerations
For CR market
- Fixed B2C customers are in scope.
- jobType should be "installation".
- Default value of relatedParty.id is "17_AURORA", which is the only value in scope for QA enviroment for Installation Technician visit in SAN JOSE. For production, this value will be based on the location for Installation.
- No data validation is present in the Mulesoft.
- Error message from the backend system is captured in the error response.
- Available timeslots are captured in the Mulesoft response.
- backend response from dlo is in UTC timeZone.
- starttime and endtime in the request and availableTimeSlot in response are in Costa Rica localtime.
- Refer dlo_Response for the sample response.
- Queryparameters jobType, requestedStartDate, requestedEndDate and relatedParty.id are mandatory to retrieve timeslots for CR Market installation.
- Please refer to below url for the response examples : [https://anypoint.mulesoft.com/exchange/portals/cable-and-wireless/c03653f5-9c46-4e55-bf97-5cef1442bfbf/appointment-biz/minor/1.0/console/method/%234084/]